| Package | hl7.fhir.uv.bulkdata |
| Type | ImplementationGuide |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/bulkdata/https://build.fhir.org/ig/HL7/bulk-data/index.html |
| Url | http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata |
| Version | 2.0.0 |
| Status | draft |
| Date | 2024-08-05T16:14:42+00:00 |
| Name | BulkDataAccessIG |
| Title | Bulk Data Access IG |
| Experimental | False |
| Realm | uv |
| Authority | hl7 |
| Description | FHIR based approach for exporting large data sets from a FHIR server to a client application |
| CapabilityStatement | |
bulk-data  | FHIR Bulk Data Access Implementation Guide |
| http://hl7.org/fhir/us/mcc/CapabilityStatement/mcc-client | MCC Client CapabilityStatement |
| http://hl7.org/fhir/us/mcc/CapabilityStatement/mcc-server | MCC Server CapabilityStatement |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide hl7.fhir.uv.bulkdata
The official URL for this implementation guide is:
http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata
FHIR based approach for exporting large data sets from a FHIR server to a client application
FHIR{
"resourceType" : "ImplementationGuide",
"id" : "hl7.fhir.uv.bulkdata",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ImplementationGuide hl7.fhir.uv.bulkdata</b></p><a name=\"hl7.fhir.uv.bulkdata\"> </a><a name=\"hchl7.fhir.uv.bulkdata\"> </a><a name=\"hl7.fhir.uv.bulkdata-en-US\"> </a><h2>BulkDataAccessIG</h2><p>The official URL for this implementation guide is: </p><pre>http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata</pre><div><p>FHIR based approach for exporting large data sets from a FHIR server to a client application</p>\n</div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}
],
"url" : "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata",
"version" : "2.0.0",
"name" : "BulkDataAccessIG",
"title" : "Bulk Data Access IG",
"status" : "draft",
"date" : "2024-08-05T16:14:42+00:00",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [
{
"name" : "HL7 International / FHIR Infrastructure",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
},
{
"system" : "email",
"value" : "fhir@lists.HL7.org"
}
]
}
],
"description" : "FHIR based approach for exporting large data sets from a FHIR server to a client application",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"packageId" : "hl7.fhir.uv.bulkdata",
"license" : "CC0-1.0",
"fhirVersion" : [
"4.0.1"
],
"dependsOn" : [
{
"id" : "hl7ext",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown" : "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
}
],
"uri" : "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId" : "hl7.fhir.uv.extensions.r4",
"version" : "5.1.0"
},
{
"id" : "terminology",
"uri" : "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId" : "hl7.terminology.r4",
"version" : "5.5.0"
}
],
"definition" : {
"extension" : [
{
"extension" : [
{
"url" : "code",
"valueString" : "copyrightyear"
},
{
"url" : "value",
"valueString" : "2021+"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "releaselabel"
},
{
"url" : "value",
"valueString" : "ci-build"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "excludettl"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "excludexml"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "excludemap"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-history"
},
{
"url" : "value",
"valueString" : "http://hl7.org/fhir/uv/bulkdata/history.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "autoload-resources"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-liquid"
},
{
"url" : "value",
"valueString" : "template/liquid"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-liquid"
},
{
"url" : "value",
"valueString" : "input/liquid"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-qa"
},
{
"url" : "value",
"valueString" : "temp/qa"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-temp"
},
{
"url" : "value",
"valueString" : "temp/pages"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-output"
},
{
"url" : "value",
"valueString" : "output"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-suppressed-warnings"
},
{
"url" : "value",
"valueString" : "input/ignoreWarnings.txt"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "template-html"
},
{
"url" : "value",
"valueString" : "template-page.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "template-md"
},
{
"url" : "value",
"valueString" : "template-page-md.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-contact"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-context"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-copyright"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-jurisdiction"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-license"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-publisher"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-version"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "apply-wg"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "active-tables"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "fmm-definition"
},
{
"url" : "value",
"valueString" : "http://hl7.org/fhir/versions.html#maturity"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "propagate-status"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "excludelogbinaryformat"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "tabbed-snapshots"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode" : "hl7.fhir.uv.tools#0.1.0"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "copyrightyear"
},
{
"url" : "value",
"valueString" : "2021+"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "releaselabel"
},
{
"url" : "value",
"valueString" : "ci-build"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "excludettl"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "excludexml"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "excludemap"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-history"
},
{
"url" : "value",
"valueString" : "http://hl7.org/fhir/uv/bulkdata/history.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "autoload-resources"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-liquid"
},
{
"url" : "value",
"valueString" : "template/liquid"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-liquid"
},
{
"url" : "value",
"valueString" : "input/liquid"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-qa"
},
{
"url" : "value",
"valueString" : "temp/qa"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-temp"
},
{
"url" : "value",
"valueString" : "temp/pages"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-output"
},
{
"url" : "value",
"valueString" : "output"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "path-suppressed-warnings"
},
{
"url" : "value",
"valueString" : "input/ignoreWarnings.txt"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "template-html"
},
{
"url" : "value",
"valueString" : "template-page.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "template-md"
},
{
"url" : "value",
"valueString" : "template-page-md.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-contact"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-context"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-copyright"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-jurisdiction"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-license"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-publisher"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-version"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "apply-wg"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "active-tables"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "fmm-definition"
},
{
"url" : "value",
"valueString" : "http://hl7.org/fhir/versions.html#maturity"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "propagate-status"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "excludelogbinaryformat"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueCode" : "tabbed-snapshots"
},
{
"url" : "value",
"valueString" : "true"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
}
],
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "CapabilityStatement"
}
],
"reference" : {
"reference" : "CapabilityStatement/bulk-data"
},
"name" : "Capability Statement",
"description" : "The expected capabilities of a Bulk Data Provider actor (e.g., EHR systems, data warehouses, and other clinical and administrative systems that aim to interoperate by sharing large FHIR datasets) which is responsible for providing responses to the queries submitted by a FHIR Bulk Data Client actor. Systems implementing this capability statement should meet the requirements set by the Bulk Data Access Implementation Guide. A FHIR Bulk Data Client has the option of choosing from this list to access necessary data based on use cases and other contextual requirements.",
"exampleBoolean" : false
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "OperationDefinition"
}
],
"reference" : {
"reference" : "OperationDefinition/export"
},
"name" : "System Level Export Operation Definition",
"description" : "FHIR Operation to export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html)",
"exampleBoolean" : false
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "OperationDefinition"
}
],
"reference" : {
"reference" : "OperationDefinition/group-export"
},
"name" : "Group Level Export Operation Definition",
"description" : "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all members of the specified [Group](https://www.hl7.org/fhir/group.html). The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html)",
"exampleBoolean" : false
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "OperationDefinition"
}
],
"reference" : {
"reference" : "OperationDefinition/patient-export"
},
"name" : "Patient Level Export Operation Definition",
"description" : "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html)",
"exampleBoolean" : false
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "ValueSet"
}
],
"reference" : {
"reference" : "ValueSet/include-associated-data"
},
"name" : "Include Associated Data Value Set",
"description" : "Metadata inclusion options for Bulk Data Access Export Operation includeAssociatedData parameter",
"exampleBoolean" : false
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "CodeSystem"
}
],
"reference" : {
"reference" : "CodeSystem/include-associated-data"
},
"name" : "Include Associated Data Code System",
"description" : "Metadata inclusion options for Bulk Data Access Export Operation includeAssociatedData parameter",
"exampleBoolean" : false
}
],
"page" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "toc.html"
}
],
"nameUrl" : "toc.html",
"title" : "Table of Contents",
"generation" : "html",
"page" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "index.html"
}
],
"nameUrl" : "index.html",
"title" : "Home",
"generation" : "markdown"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "export.html"
}
],
"nameUrl" : "export.html",
"title" : "Export",
"generation" : "markdown"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "authorization.html"
}
],
"nameUrl" : "authorization.html",
"title" : "SMART Backend Services Authorization",
"generation" : "markdown"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "abbreviations.html"
}
],
"nameUrl" : "abbreviations.html",
"title" : "Abbreviations",
"generation" : "markdown"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "changes.html"
}
],
"nameUrl" : "changes.html",
"title" : "IG Change History",
"generation" : "markdown"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl" : "downloads.html"
}
],
"nameUrl" : "downloads.html",
"title" : "Downloads",
"generation" : "html"
}
]
},
"parameter" : [
{
"code" : "path-resource",
"value" : "input/capabilities"
},
{
"code" : "path-resource",
"value" : "input/examples"
},
{
"code" : "path-resource",
"value" : "input/extensions"
},
{
"code" : "path-resource",
"value" : "input/models"
},
{
"code" : "path-resource",
"value" : "input/operations"
},
{
"code" : "path-resource",
"value" : "input/profiles"
},
{
"code" : "path-resource",
"value" : "input/resources"
},
{
"code" : "path-resource",
"value" : "input/vocabulary"
},
{
"code" : "path-resource",
"value" : "input/maps"
},
{
"code" : "path-resource",
"value" : "input/testing"
},
{
"code" : "path-resource",
"value" : "input/history"
},
{
"code" : "path-resource",
"value" : "fsh-generated/resources"
},
{
"code" : "path-pages",
"value" : "template/config"
},
{
"code" : "path-pages",
"value" : "input/images"
},
{
"code" : "path-tx-cache",
"value" : "input-cache/txcache"
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.